/*
 * Copyright 2012 Marsrutai.lt
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package lt.marsrutai.mobile.android.service;

import android.location.Location;

/**
 * Provides methods to access current location
 * 
 * @author Justas
 */
public interface LocationProvider {

    /**
     * @return Current best location fix
     */
    Location getCurrentBestLocation();

    /**
     * Starts listening for location updates
     */
    void start();

    /**
     * Stops listening for location updates
     */
    void stop();

    /**
     * <p>
     * Indicates whether this location provider is receiving location updates.
     * </p>
     * <p>
     * {@link #getCurrentBestLocation()} might return <code>null</code> if no
     * location is yet received (e.g. first update takes a lot of time), this
     * method helps to determine whether changes to the return value are to be
     * expected.
     * </p>
     * 
     * @return
     */
    boolean isReceivingUpdates();
}
